/*
 *  Copyright (C) 2010 Fabien Renaud
 * 
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 * 
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 * 
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.boc.botv.service;

import com.boc.botv.model.BankTransaction;
import java.util.List;

/**
 * Gestionnaire de transactions banquaires
 * @author Fabien Renaud
 */
public interface BankTransactionManager {

  /**
   * Permet d'obtenir l'ensemble des transactions banquaires
   * @return l'ensemble des transactions banquaires
   */
  public List<BankTransaction> getBankTransactions();

  /**
   * Permet d'obtenir l'ensemble des transactions d'un utilisateur
   * @param userId l'id de l'utilisateur
   * @return la liste des transactions
   */
  public List<BankTransaction> getBankTransactions(int userId);

  /**
   * Permet d'obtenir l'ensemble des transactions approuvées d'un utilisateur
   * @param userId l'id de l'utilisateur
   * @return la liste des transactions approuvées
   */
  public List<BankTransaction> getApprovedBankTransactions(int userId);

  /**
   * Permet d'obtenir l'ensemble des transactions en attentes d'approbation d'un utilisateur
   * @param userId l'id de l'utilisateur
   * @return la liste des transactions en attentes
   */
  public List<BankTransaction> getUnapprovedBankTransactions(int userId);

  /**
   * Permet d'approuverune transaction banquaire
   * @param id l'id de la transaction à approuver
   * @return true si la transaction a été correctement approuvé
   */
  public abstract boolean approveBankTransaction(int id);

  /**
   * Crée une transaction banquaire. Retrait du compte virtuel vers le compte réel.
   * @param userId l'id de l'utilisateur
   * @param amount le montant à débiter
   * @return true si le débit s'est correctement déroulé
   */
  public boolean debitVirtualAccount(int userId, double amount);

  /**
   * Crée une transaction banquaire. Dépot sur le compte virtuel à partir du compte réel.
   * @param userId l'id de l'utilisateur
   * @param amount le montant à créditer
   * @return true si le crédit s'est correctement déroulé
   */
  public boolean creditVirtualAccount(int userId, double amount);
}
